home *** CD-ROM | disk | FTP | other *** search
/ The Arsenal Files 6 / The Arsenal Files 6 (Arsenal Computer).ISO / telegard / tgstat12.zip / TGSTAT.DOC < prev    next >
Text File  |  1996-01-26  |  20KB  |  456 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.          TGStat v1.2
  9.          Telegard All Status Bulletin Generator
  10.  
  11.          Copyright (C) 1995-96 MicroEuropa Informática, Lda.
  12.          All rights reserved.
  13.  
  14.          For use with Telegard Bulletin Board System v3.0+ ONLY!
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.          _________
  25.          COPYRIGHT
  26.  
  27.          This  document,  TGStat  and  all  files  associated  to TGStat are
  28.          Copyright (C) 1995-96 MicroEuropa Informática, Lda.
  29.          All rights reserved.
  30.  
  31.          TELEGARD v3.0 is Copyright (C) 1995-96 by Tim Strike.
  32.          Other  brand  and  product   names  are  trademarks  or  registered
  33.          trademarks of their respective holders.
  34.  
  35.          MicroEuropa Informática (C) 1995-96
  36.          Company ID: 501190252
  37.  
  38.  
  39.          _______
  40.          LICENSE
  41.  
  42.          TGStat and related utilities are not Public Domain.
  43.          You  can use  this software  for  the  time that  you like,  if the
  44.          original files and related documents are not modified. This program
  45.          is Freeware.
  46.  
  47.  
  48.  
  49.          __________
  50.          WARRANTIES
  51.  
  52.          None. Use this software at your own risk.
  53.  
  54.  
  55.  
  56.          ________
  57.          FEATURES
  58.  
  59.          TGStat is a statistical bulletin generator, it allows you to create
  60.          unlimited  bulletins  about  users  in  your  system,  according to
  61.          several parameters.
  62.  
  63.             *  Fast buffered users list read and sort
  64.             *  More than 340 MCI codes supported
  65.             *  Sorts users list for 15 different categories
  66.             *  Can create an Unlimeted number of bulletins in ONE PASS!
  67.             *  Supports Left, Right and Center justify TG MCI codes
  68.             *  Supports date expand (to string) MCI codes
  69.             *  Allow to visualize on screen the created bulletin
  70.             *  Test mode features. Visualize with no writing on disk.
  71.             *  Allow to run templates  on command line  or in a  config file
  72.                where you can specify unlimeted number of files to process.
  73.  
  74.          In this release was not included  YET the following features, but I
  75.          am already working in their implementation:
  76.  
  77.             *  Support for History file
  78.             *  Support for File Area bulletins (top dl files, etc)
  79.             *  Full support for Tim Strike "HISTINFO" program MCI codes
  80.             *  Any sugestion that you might have... :)
  81.  
  82.  
  83.  
  84.          ______
  85.          TGSTAT
  86.  
  87.          The following is  the operation modes in TGStat,  the first example
  88.          is for a  simple execution with the filenames  of the template file
  89.          and  the bulletin  to be  created given  on the  command line.  The
  90.          second example is the execution of the program using a config file.
  91.  
  92.          TGSTAT <template> <Bulletin> /V /NW /P:<path>
  93.  
  94.          or...
  95.  
  96.          TGSTAT /C:<path and filename> /V /NW /ND /T:<seconds> /P:<path>
  97.  
  98.          The command line options are described above:
  99.          -------------------------------------------------------------------
  100.          /C:<path+filename> .... Path and Filename of the configuration file
  101.                                  to process.
  102.          /P:<path> ............. Path  to  your  main  TG  directory  (where
  103.                                  CONFIG.TG is).
  104.          /V .................... Enable view mode. Displays the bulletins at
  105.                                  the same time they are written in the disk.
  106.          /NW ................... Disable the  writing on disk. The templates
  107.                                  processed can be only displayed.
  108.          /T:<seconds> .......... Fixes the display time in view mode between
  109.                                  bulletins.  The  default   is  15  seconds.
  110.                                  Afects only the execution  if a config file
  111.                                  is used,  in command line mode  it does not
  112.                                  afect the display.
  113.          /ND ................... Disable the display time between bulletins.
  114.          -------------------------------------------------------------------
  115.  
  116.          Nest follows a pratic example of a command line to process only one
  117.          template allowing to visualize the template  at the same time it is
  118.          created.
  119.  
  120.          TGSTAT C:\BBS\TGSTAT\TGSTAT01.TPL C:\BBS\TEXT\BULLET1.MSG /V
  121.  
  122.          The following command line will  process a config file, pausing the
  123.          display of the bulletins for  30 seconds before processing the next
  124.          one.
  125.  
  126.          TGSTAT C:\BBS\TGSTAT\TGSTAT.CFG /T:30 /V
  127.  
  128.          The  following command  line will   allow the  SysOp to  "test" the
  129.          template  to  see  if  everything  is  allright  before the program
  130.          generates bulletins in the disk. This is a test mode operation only.
  131.  
  132.          TGSTAT C:\BBS\TGSTAT\MYBBS.TPL /NW
  133.  
  134.          or...
  135.  
  136.          TGSTAT /C:C:\BBS\TGSTAT\MYBBS.CFG /NW /T:30
  137.  
  138.  
  139.          If  you  wish  to  process  a  list  of  files  only in one program
  140.          execution, you should create a config file and edit it with a plain
  141.          text editor. The file should look something like this:
  142.  
  143.          ---[TGSTAT.CFG-----------------------------------------------------
  144.          ; This is a sample for TGSTAT.CFG file.
  145.          ; You can modify as you wish.
  146.          ;
  147.          ; First process the TG MCI (*.MSG) files.
  148.          TGSTAT01.TPL          C:\BBS\TEXT\BULLET1.MSG
  149.          TGSTAT02.TPL          C:\BBS\TEXT\BULLET2.MSG
  150.          TGSTAT03.TPL          C:\BBS\TEXT\BULLET3.MSG
  151.          GLOBAL.TPL            C:\BBS\TEXT\BULLET4.MSG
  152.          ; Now the ANSI files.
  153.          C:\ANSI\TGSTAT01.ANS  C:\BBS\TEXT\BULLET4.ANS
  154.          C:\ANSI\TGSTAT02.ANS  C:\BBS\TEXT\BULLET4.ANS
  155.          C:\ANSI\TGSTAT03.ANS  C:\BBS\TEXT\BULLET4.ANS
  156.          C:\ANSI\GLOBAL.ANS    C:\BBS\TEXT\BULLET4.ANS
  157.          -------------------------------------------------------------------
  158.  
  159.          The format is  pretty simple, in each line you  will give FIRST the
  160.          location (in  case it isn't in  current directory) and name  of the
  161.          template file and in SECOND the path and name for the new bulletin.
  162.          You can add UNLIMITED number of  lines to this config file,  if the
  163.          above format is allways respected.
  164.  
  165.          Lines starting with a ; will be ignored.
  166.  
  167.          TGStat was designed to process TG  MCI codes and color codes files,
  168.          but it will process very well  ANSI or AVATAR files since you don't
  169.          forget to reserve space to the output of the MCI code.
  170.  
  171.  
  172.  
  173.          ________________
  174.          TGSTAT OPERATION
  175.  
  176.          * USERS LIST
  177.            TGStat will read users list file  and process the data in the way
  178.            that you will get through the  TGStat MCI codes list all the data
  179.            of  the  15  top  users  in  each  of  the diferent 17 categories
  180.            processed. The categories are:
  181.  
  182.              . Youngest
  183.              . Oldest
  184.              . Public posts
  185.              . Private posts
  186.              . Netmail posts
  187.              . # uploads
  188.              . # downloads
  189.              . # kb uploaded
  190.              . # kb downloaded
  191.              . Online time
  192.              . Calls
  193.              . Total posts
  194.              . Post/Call ratio
  195.              . Newest caller
  196.              . Oldest caller
  197.              . User that do not call for more time
  198.              . Last user
  199.  
  200.          TGStat  will  give  you  the  first  15  top  users in each of this
  201.          categories.
  202.  
  203.          * HISTORY
  204.            Not supported, yet!
  205.  
  206.          * FILE LIST
  207.            Not supported, yet!
  208.  
  209.  
  210.          _________________________
  211.          TGSTAT MCI REFERENCE LIST
  212.  
  213.          This MCI codes can be used  when creating a template for the TGStat
  214.          process.  YOU CAN  USE THE  TELEGARD MCI  CODES ALSO because TGStat
  215.          will not process them, so they  will only be "interpreted" when the
  216.          file is displayed inside the TG.
  217.  
  218.          This table is divided in two parts to be more "readble".
  219.  
  220.                        Name    BDay   PubP   PrvP   NetP   TotP   PCR
  221.          Youngest       ~!L    ~!M    ~!N    ~!O    ~!P    ~!Q    ~!R
  222.          Oldest         ~?L    ~?M    ~?N    ~?O    ~?P    ~?Q    ~?R
  223.          Public Pst     ~@L    ~@M    ~@N    ~@O    ~@P    ~@Q    ~@R
  224.          Private Pst    ~#L    ~#M    ~#N    ~#O    ~#P    ~#Q    ~#R
  225.          Netmail Pst    ~$L    ~$M    ~$N    ~$O    ~$P    ~$Q    ~$R
  226.          # Up           ~&L    ~&M    ~&N    ~&O    ~&P    ~&Q    ~&R
  227.          # Down         ~%L    ~%M    ~%N    ~%O    ~%P    ~%Q    ~%R
  228.          # Kb Upl       ~=L    ~=M    ~=N    ~=O    ~=P    ~=Q    ~=R
  229.          # Kb Down      ~-L    ~-M    ~-N    ~-O    ~-P    ~-Q    ~-R
  230.          Online         ~^L    ~^M    ~^N    ~^O    ~^P    ~^Q    ~^R
  231.          Calls          ~+L    ~+M    ~+N    ~+O    ~+P    ~+Q    ~+R
  232.          Top Poster     ~}L    ~}M    ~}N    ~}O    ~}P    ~}Q    ~}R
  233.          Top PCR        ~{L    ~{M    ~{N    ~{O    ~{P    ~{Q    ~{R
  234.          Newest caller  ~/L    ~/M    ~/N    ~/O    ~/P    ~/Q    ~/R
  235.          Oldest caller  ~\L    ~\M    ~\N    ~\O    ~\P    ~\Q    ~\R
  236.          Don't cl 4+ ti ~»L    ~»M    ~»N    ~»O    ~»P    ~»Q    ~»R
  237.          Oldest caller  ~«L    ~«M    ~«N    ~«O    ~«P    ~«Q    ~«R
  238.  
  239.                         Up#    Dl#    UKb    DKb    Time   LgOn   Frst  Last
  240.          Youngest       ~!S    ~!T    ~!U    ~!V    ~!W    ~!X    ~!Y   ~!Z
  241.          Oldest         ~?S    ~?T    ~?U    ~?V    ~?W    ~?X    ~?Y   ~?Z
  242.          Public Pst     ~@S    ~@T    ~@U    ~@V    ~@W    ~@X    ~@Y   ~@Z
  243.          Private Pst    ~#S    ~#T    ~#U    ~#V    ~#W    ~#X    ~#Y   ~#Z
  244.          Netmail Pst    ~$S    ~$T    ~$U    ~$V    ~$W    ~$X    ~$Y   ~$Z
  245.          # Up           ~&S    ~&T    ~&U    ~&V    ~&W    ~&X    ~&Y   ~&Z
  246.          # Down         ~%S    ~%T    ~%U    ~%V    ~%W    ~%X    ~%Y   ~%Z
  247.          # Kb Upl       ~=S    ~=T    ~=U    ~=V    ~=W    ~=X    ~=Y   ~=Z
  248.          # Kb Down      ~-S    ~-T    ~-U    ~-V    ~-W    ~-X    ~-Y   ~-Z
  249.          Online         ~^S    ~^T    ~^U    ~^V    ~^W    ~^X    ~^Y   ~^Z
  250.          Calls          ~+S    ~+T    ~+U    ~+V    ~+W    ~+X    ~+Y   ~+Z
  251.          Top Poster     ~}S    ~}T    ~}U    ~}V    ~}W    ~}X    ~}Y   ~{Z
  252.          Top PCR        ~{S    ~{T    ~{U    ~{V    ~{W    ~{X    ~{Y   ~}Z
  253.          Newest caller  ~/S    ~/T    ~/U    ~/V    ~/W    ~/X    ~/Y   ~/Z
  254.          Oldest caller  ~\S    ~\T    ~\U    ~\V    ~\W    ~\X    ~\Y   ~\Z
  255.          Don't cl 4+ ti ~»S    ~»T    ~»U    ~»V    ~»W    ~»X    ~»Y   ~»Z
  256.          Lastest caller ~«S    ~«T    ~«U    ~«V    ~«W    ~«X    ~«Y   ~«Z
  257.  
  258.  
  259.            ~ELnn   Left-justify next MCI code in field of nn characters.
  260.            ~ERnn   Right-justify next MCI code in field of nn characters.
  261.            ~ECnn   Center next MCI code in field of nn characters.
  262.  
  263.            ~[Dnn   Displays the day in string format
  264.            ~[Mnn   Displays the month in string format
  265.            ~[Ynn   Displays the year in string format
  266.            ~[Wnn   Displays the day of week in the string format
  267.            ~]Dnn   Display the day in numeric format
  268.            ~]Mnn   Display the month in numeric format
  269.            ~]Ynn   Display the year in numeric format
  270.            (nn is the date MCI that should be interpreted)
  271.  
  272.          Actually, the ~]D or the ~[D  are the same (YET), because they both
  273.          return  the  day  of  month  as   a  number.  The  other  MCI  date
  274.          interpretation MCI  codes, return as  a number or  as a string  for
  275.          example for  the month of July  the ~]M MCI will  return the string
  276.          "July" and the ~[M MCI will return the number 07.
  277.  
  278.  
  279.          ________________
  280.          TGSTAT MCI USAGE
  281.  
  282.          How to use the information MCI's?
  283.  
  284.          To use  the information/data MCI's,  you should write  the MCI down
  285.          and then write the user that you want to know the information.
  286.          For example  the ~!L MCI  will give you  the name of  one of the 15
  287.          Youngest users on  your system, to choose the  "rank" that you want
  288.          to display you  should add a number following  the MCI, for example
  289.          ~!L04  will give  you the  name of  the 4st  Youngest user  on your
  290.          system.
  291.          You should  organize data to make  top 10 lists, etc.  Here goes an
  292.          example for a  template file that will produce  the Top 10 Uploader
  293.          on your system:
  294.  
  295.                           Top 10 with most Uploaded Kbytes.
  296.               Generated by Telegard All Status Bulletin Generator v1.2.
  297.                  Copyright (C) 1995-96 MicroEuropa Informática, Lda.
  298.  
  299.          Rank         Name/Handle           Calls         Total Kb     Files
  300.          ────────────────────────────────────────────────────────────────────
  301.             1   ~EL26~=L01   ~ER04~=X01    ~ER10~=U01 Kb     ~ER05~=S01
  302.             2   ~EL26~=L02   ~ER04~=X02    ~ER10~=U02 Kb     ~ER05~=S02
  303.             3   ~EL26~=L03   ~ER04~=X03    ~ER10~=U03 Kb     ~ER05~=S03
  304.             4   ~EL26~=L04   ~ER04~=X04    ~ER10~=U04 Kb     ~ER05~=S04
  305.             5   ~EL26~=L05   ~ER04~=X05    ~ER10~=U05 Kb     ~ER05~=S05
  306.             6   ~EL26~=L06   ~ER04~=X06    ~ER10~=U06 Kb     ~ER05~=S06
  307.             7   ~EL26~=L07   ~ER04~=X07    ~ER10~=U07 Kb     ~ER05~=S07
  308.             8   ~EL26~=L08   ~ER04~=X08    ~ER10~=U08 Kb     ~ER05~=S08
  309.             9   ~EL26~=L09   ~ER04~=X09    ~ER10~=U09 Kb     ~ER05~=S09
  310.            10   ~EL26~=L10   ~ER04~=X10    ~ER10~=U10 Kb     ~ER05~=S10
  311.          ────────────────────────────────────────────────────────────────────
  312.  
  313.          Will become...
  314.  
  315.                           Top 10 with most Uploaded Kbytes.
  316.               Generated by Telegard All Status Bulletin Generator v1.2.
  317.                  Copyright (C) 1995-96 MicroEuropa Informática, Lda.
  318.  
  319.          Rank         Name/Handle           Calls         Total Kb     Files
  320.          ────────────────────────────────────────────────────────────────────
  321.             1   Banco                         358         88590 Kb       721
  322.             2   Joaquim Gil                   265         58455 Kb       336
  323.             3   Shadow                        245          5873 Kb        37
  324.             4   Death'S Law                   187          4702 Kb        21
  325.             5   Highlander                    472          4480 Kb        14
  326.             6   Super Vga                      87          3657 Kb        16
  327.             7   Waveaollic Dude               119          2412 Kb         5
  328.             8   Dominus Chaos                   7          2201 Kb         7
  329.             9   Armando Arranja                18          2070 Kb         4
  330.            10   Paulo Js Rodrigues             62          2037 Kb        11
  331.          ────────────────────────────────────────────────────────────────────
  332.  
  333.          A set  of  default  templates  is  shiped  with  this version, they
  334.          support color and you can modify them as you wish.
  335.  
  336.          The rank/position of  the user to be added to  the MCI code, SHOULD
  337.          BE ALLWAYS  A TWO DIGIT number.  If the rank to  be displayed is 4,
  338.          you should write 04.
  339.  
  340.  
  341.          How to use date interpretation MCI's?
  342.  
  343.          To make  the date interpretation  MCI's to work,  you will need  to
  344.          give  a date  to be  processed, like  First On  date, Last On date,
  345.          birthdate, etc.
  346.          For example the Birthdate MCI for  the youngest user on your system
  347.          is ~!M. You will  like to work with the nr.1 in  your list, the TOP
  348.          youngest user, so you will have to  had the rank after the MCI, the
  349.          MCI  will now  look like  this ~!M01.  If you  put this  in a file,
  350.          TGStat after process the file will  convert this MCI to a date like
  351.          74/06/12 (YY/MM/DD).
  352.          If you  wish to process  this MCI to  extract the Week  day of this
  353.          date, you should use the ~[W MCI like this ~[W~!M01 and TGStat will
  354.          replace this two  MCI's with the day of the  week that this user as
  355.          born.
  356.          Now follows an example for a  template that will produce the Top 10
  357.          Youngest users on your system. This template will write an extended
  358.          birthdate of the users.
  359.  
  360.                                Top 10 Youngest users.
  361.               Generated by Telegard All Status Bulletin Generator v1.2.
  362.                  Copyright (C) 1995-96 MicroEuropa Informática, Lda.
  363.  
  364.          Rank           Name/Handle                       Birthdate
  365.          ───────────────────────────────────────────────────────────────────
  366.             1   ~EL22~!L01 ~ER14~[M~!M01 ~[D~!M01 Of ~[Y~!M01, ~ER09~[W~!M01
  367.             2   ~EL22~!L02 ~ER14~[M~!M02 ~[D~!M02 Of ~[Y~!M02, ~ER09~[W~!M02
  368.             3   ~EL22~!L03 ~ER14~[M~!M03 ~[D~!M03 Of ~[Y~!M03, ~ER09~[W~!M03
  369.             4   ~EL22~!L04 ~ER14~[M~!M04 ~[D~!M04 Of ~[Y~!M04, ~ER09~[W~!M04
  370.             5   ~EL22~!L05 ~ER14~[M~!M05 ~[D~!M05 Of ~[Y~!M05, ~ER09~[W~!M05
  371.             6   ~EL22~!L06 ~ER14~[M~!M06 ~[D~!M06 Of ~[Y~!M06, ~ER09~[W~!M06
  372.             7   ~EL22~!L07 ~ER14~[M~!M07 ~[D~!M07 Of ~[Y~!M07, ~ER09~[W~!M07
  373.             8   ~EL22~!L08 ~ER14~[M~!M08 ~[D~!M08 Of ~[Y~!M08, ~ER09~[W~!M08
  374.             9   ~EL22~!L09 ~ER14~[M~!M09 ~[D~!M09 Of ~[Y~!M09, ~ER09~[W~!M09
  375.            10   ~EL22~!L10 ~ER14~[M~!M10 ~[D~!M10 Of ~[Y~!M10, ~ER09~[W~!M10
  376.          ───────────────────────────────────────────────────────────────────
  377.  
  378.          Will become...
  379.  
  380.                                Top 10 Youngest users.
  381.               Generated by Telegard All Status Bulletin Generator v1.2.
  382.                  Copyright (C) 1995-96 MicroEuropa Informática, Lda.
  383.  
  384.          Rank           Name/Handle                       Birthdate
  385.          ───────────────────────────────────────────────────────────────────
  386.             1   Pedro Miguel Lopes Dos       December 12 Of 1987,   Tuesday
  387.             2   Guest                        February 02 Of 1983, Wednesday
  388.             3   Vlad Nosferatu                   July 07 Of 1983,  Saturday
  389.             4   Lestat                           July 07 Of 1980,  Thursday
  390.             5   Nuno Soares                      July 07 Of 1979,  Thursday
  391.             6   Paul Neves                       July 07 Of 1978,   Tuesday
  392.             7   Joao Freitas                     July 07 Of 1976, Wednesday
  393.             8   Carlos Espinha                   June 06 Of 1975,   Tuesday
  394.             9   Joao Ribeiro                 December 12 Of 1973,   Tuesday
  395.            10   Mike                         December 12 Of 1973,    Monday
  396.          ───────────────────────────────────────────────────────────────────
  397.  
  398.          Note, that all  data given is only and example  and date and day of
  399.          week may not be right.
  400.  
  401.  
  402.          ______
  403.          FUTURE
  404.  
  405.          If  I got  the time  and receive  enough support  to continue, more
  406.          releases will come... .and better ones I hope! <g>
  407.  
  408.  
  409.          ___________
  410.          BUG REPORTS
  411.  
  412.          *** PLEASE SUPPORT THIS SOFTWARE REPORTING ANY BUGS FOUND!
  413.  
  414.          You can use  the TG_BETA or TG_SUPPORT conferences  to reach me. My
  415.          netmail  address is  2:362/46. You  can also  reach me  by internet
  416.          E-Mail "microeuropa.telepac.pt"
  417.  
  418.  
  419.  
  420.          ____________
  421.          REGISTRATION
  422.  
  423.          None.
  424.          I decided that  this (and a  few others) utilities  for TG 3.0  are
  425.          going to be Freeware.
  426.  
  427.  
  428.  
  429.          _______
  430.          CONTACT
  431.  
  432.          You can contact the author in the Fidonet address 2:362/46.
  433.          If you whish you can call to MicroEuropa Informática support BBS:
  434.  
  435.            PARADiSE CiTY
  436.            +351 (0)1 4602328
  437.            28,8k (V.34, V.Fast) / 900MB, CDROM (Programmers Devoted System)
  438.  
  439.            Fidonet : 2:362/46
  440.            Intelec : 239:2/40
  441.            Lusonet : 16:16005/8
  442.  
  443.  
  444.          By Snail E-Mail
  445.  
  446.            MicroEuropa Informática, Lda.
  447.            Av. Cardoso Lopes
  448.            2700 AMADORA, PORTUGAL (Europe)
  449.  
  450.          By Internet E-Mail
  451.  
  452.            microeuropa@telepac.pt
  453.  
  454.  
  455.          THANKS BY YOUR TIME!
  456.